home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / a_man / cat1 / fcagent.z / fcagent
Encoding:
Text File  |  2001-04-17  |  13.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. ffffccccaaaaggggeeeennnntttt((((1111mmmm))))                                                        ffffccccaaaaggggeeeennnntttt((((1111mmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ffffccccaaaaggggeeeennnntttt - FibreVault Status/Configuration daemon
  10.  
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ffffccccaaaaggggeeeennnntttt _f_c_a_g_e_n_t-_o_p_t_i_o_n_s-_f_i_l_e
  14.  
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      ffffccccaaaaggggeeeennnntttt and ffffcccccccclllliiii have been deprecated in favor of a new fibre channel
  18.      drive manager sssseeeessssddddaaaaeeeemmmmoooonnnn and sssseeeessssmmmmggggrrrr.  Accordingly, fcagent is now
  19.      chkconfig off by default.
  20.  
  21.      ffffccccaaaaggggeeeennnntttt is a daemon which allows communication with attached FibreVault
  22.      enclosures; status is collected and re-configuration is allowed.
  23.  
  24.      The low-level transport protocol is the industry standard SES (SCSI-3
  25.      Enclosure Services). The top-level transport is via RPC to allow for
  26.      remote system monitoring and control. See ffffcccccccclllliiii((((1111MMMM)))) for details.
  27.  
  28.      The ffffccccaaaaggggeeeennnntttt is normally started automatically during boot if ffffccccaaaaggggeeeennnntttt is
  29.      cccchhhhkkkkccccoooonnnnffffiiiigggg'ed oooonnnn. Three processes are started for each instance of
  30.      ffffccccaaaaggggeeeennnntttt; the backend polling thread which handles polling the FibreVault
  31.      enclosures for status, the frontend RPC thread which is responsible for
  32.      communication with user interfaces like ffffcccccccclllliiii, and an event handler
  33.      thread which handles FRU status change events. Each event results in a
  34.      user configurable callout shell script being executed. These scripts are
  35.      user customizable.
  36.  
  37.  
  38. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  39.      The _f_c_a_g_e_n_t-_o_p_t_i_o_n_s-_f_i_l_e is provided for customizing certain aspects of
  40.      ffffccccaaaaggggeeeennnntttt operation. This file normally resides at
  41.      ////eeeettttcccc////ccccoooonnnnffffiiiigggg////ffffccccaaaaggggeeeennnntttt....ooooppppttttiiiioooonnnnssss. The contents of the file is a list of
  42.      customizable variables and their values.
  43.  
  44.      PPPPoooollllllllPPPPeeeerrrriiiioooodddd     Specifies the time, in seconds, between successive polls
  45.                     of a particular FibreVault enclosure. Status change
  46.                     detection is not interrupt driven so status changes will
  47.                     not be detected until the next poll period. The default
  48.                     value is 66660000.
  49.  
  50.      FFFFllllaaaasssshhhhPPPPeeeerrrriiiioooodddd    Specifies the "flash-period", in 1/10ths seconds,
  51.                     pertaining to the ffffcccccccclllliiii ffffllllaaaasssshhhh command. The default value
  52.                     is 5555.
  53.  
  54.      PPPPrrrreeeeRRRReeeemmmmoooovvvvaaaallllCCCCaaaalllllllloooouuuutttt
  55.                     Specifies the pathname of the script to be executed just
  56.                     prior to performing a ffffcccccccclllliiii rrrreeeemmmmoooovvvveeee or bbbbyyyyppppaaaassssssss command. The
  57.                     default value is ////uuuussssrrrr////lllliiiibbbb////ffffccccaaaaggggeeeennnntttt////pppprrrreeeerrrreeeemmmmoooovvvveeee....CCCCOOOO.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ffffccccaaaaggggeeeennnntttt((((1111mmmm))))                                                        ffffccccaaaaggggeeeennnntttt((((1111mmmm))))
  71.  
  72.  
  73.  
  74.      PPPPoooossssttttRRRReeeemmmmoooovvvvaaaallllCCCCaaaalllllllloooouuuutttt
  75.                     Specifies the pathname of the script to be executed
  76.                     immediately following the performance of a ffffcccccccclllliiii rrrreeeemmmmoooovvvveeee or
  77.                     bbbbyyyyppppaaaassssssss command. The default value is
  78.                     ////uuuussssrrrr////lllliiiibbbb////ffffccccaaaaggggeeeennnntttt////ppppoooossssttttrrrreeeemmmmoooovvvveeee....CCCCOOOO.
  79.  
  80.      PPPPoooossssttttIIIInnnnsssseeeerrrrttttiiiioooonnnnCCCCaaaalllllllloooouuuutttt
  81.                     Specifies the pathname of the script to be executed
  82.                     immediately following the performance of a ffffcccccccclllliiii iiiinnnnsssseeeerrrrtttt or
  83.                     uuuunnnnbbbbyyyyppppaaaassssssss command. The default value is
  84.                     ////uuuussssrrrr////lllliiiibbbb////ffffccccaaaaggggeeeennnntttt////ppppoooossssttttiiiinnnnsssseeeerrrrtttt....CCCCOOOO.
  85.  
  86.      SSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddCCCCaaaalllllllloooouuuutttt
  87.                     Specifies the pathname of the script to be executed
  88.                     following a FRU status change. The default value is
  89.                     ////uuuussssrrrr////lllliiiibbbb////ffffccccaaaaggggeeeennnntttt////ssssttttaaaattttcccchhhhaaaannnnggggeeeedddd....CCCCOOOO.
  90.  
  91.      DDDDeeeebbbbuuuuggggLLLLeeeevvvveeeellll     Specifies the "verbosity" of ffffccccaaaaggggeeeennnntttt. The default value is
  92.                     0000.
  93.  
  94.      AAAAlllllllloooowwwwRRRReeeemmmmooootttteeeeRRRReeeeqqqquuuueeeessssttttssss
  95.                     Tells ffffccccaaaaggggeeeennnntttt to process requests that are not from
  96.                     localhost on a reserved port.  This option allows any host
  97.                     on the network to perform any operation.  The default
  98.                     value is 0000, and can be set to 1111 to allow remote requests.
  99.  
  100.  
  101. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN OOOOFFFF EEEEVVVVEEEENNNNTTTT CCCCAAAALLLLLLLLOOOOUUUUTTTT SSSSCCCCRRRRIIIIPPPPTTTTSSSS
  102.      The ffffccccaaaaggggeeeennnntttt event handler executes one or more callout scripts in
  103.      response to a FRU status change or user initiated reconfiguration. Each
  104.      time a script is executed, 9 arguments are passed to it which a user can
  105.      use to customize said scripts. For example, the SSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddCCCCaaaalllllllloooouuuutttt
  106.      script can be modified to send mail to a system administrator's chatty
  107.      pager should a fault be detected. The arguments are as follows:
  108.  
  109.  
  110.      _1 - _h_o_s_t _n_a_m_e  A character string specifying the name of the host machine
  111.                     where the FRU status change was detected.
  112.  
  113.      _2 - _c_a_l_l_o_u_t _t_y_p_e
  114.                     A character string specifying the callout type. The
  115.                     possible values are _I_N_F_O, _R_E_C_O_N_F_I_G and _F_A_I_L_U_R_E. The types
  116.                     can be viewed in increasing priority of importance.  The
  117.                     _I_N_F_O type is used when the FRU status change is
  118.                     informational and little or no system administrator
  119.                     intervention is needed. An example of an informational
  120.                     state change is a disk FRU transitioning from _n_o_t _p_r_e_s_e_n_t
  121.                     to _O_K following the insertion of of a previously absent
  122.                     disk drive. The _R_E_C_O_N_F_I_G type is used following a
  123.                     configuration change which may be of interest to the
  124.                     system administrator. An example of a reconfiguration
  125.                     state change is a disk FRU transitioning from _O_K to
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ffffccccaaaaggggeeeennnntttt((((1111mmmm))))                                                        ffffccccaaaaggggeeeennnntttt((((1111mmmm))))
  137.  
  138.  
  139.  
  140.                     _b_y_p_a_s_s_e_d following the execution of a ffffcccccccclllliiii bbbbyyyyppppaaaassssssss
  141.                     command. The _F_A_I_L_U_R_E type is used when system
  142.                     administrator intervention is needed due to an unexpected
  143.                     FRU failure.
  144.  
  145.      _3 - _t_i_m_e _s_t_a_m_p A character string specifying the time at which the status
  146.                     change occurred.
  147.  
  148.      _4 - _c_h_a_n_n_e_l _I_D A numerical character string specifying the channel number
  149.                     on which the state change was detected.
  150.  
  151.      _5 - _e_n_c_l_o_s_u_r_e _I_D
  152.                     A numerical character string specifying the FibreVault
  153.                     enclosure number on which the state change was detected.
  154.                     Is only specified for the case of the
  155.                     SSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddCCCCaaaalllllllloooouuuutttt. It is set to -1 for other callouts.
  156.  
  157.      _6 - _F_R_U _t_y_p_e   A character string specifying the type/class of FRU for
  158.                     which the status change is being reported. Possible values
  159.                     are _D_I_S_K (for disk FRUs), _P_S (for power supply FRUs), _F_A_N
  160.                     (for fan FRUs), and _L_C_C (for Link-Control-Card FRUs).
  161.  
  162.      _7 - _F_R_U _I_D     A numerical character string specifying the ID of the FRU
  163.                     which underwent the state change. Possible values are 0-9
  164.                     for disk FRUs, 0-1 for power supply FRUs, 0 for fan FRUs,
  165.                     and 0 for LCC FRUs.
  166.  
  167.      _8 - _S_t_a_t_e _t_r_a_n_s_i_t_i_o_n _f_r_o_m _s_t_a_t_e
  168.                     A character string specifying the from state of the FRU
  169.                     state transition. Possible values are _O_K, _O_F_F, _F_A_I_L_E_D,
  170.                     _N_O_T-_P_R_E_S_E_N_T, _B_Y_P_A_S_S_E_D, and _P_E_E_R-_F_A_I_L_E_D. Is only specified
  171.                     for the case of the SSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddCCCCaaaalllllllloooouuuutttt. Is set to -1 for
  172.                     other callouts.
  173.  
  174.      _9 - _S_t_a_t_e _t_r_a_n_s_i_t_i_o_n _t_o _s_t_a_t_e
  175.                     A character string specifying the to state of the FRU
  176.                     state transition. Possible values are _O_K, _O_F_F, _F_A_I_L_E_D,
  177.                     _N_O_T-_P_R_E_S_E_N_T, _B_Y_P_A_S_S_E_D, and _P_E_E_R-_F_A_I_L_E_D. Is only specified
  178.                     for the case of the SSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddCCCCaaaalllllllloooouuuutttt. Is set to -1 for
  179.                     other callouts.
  180.  
  181.  
  182. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  183.      The following is an example of a SSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddCCCCaaaalllllllloooouuuutttt C-shell script
  184.      which may be used to send mail to a system administrator following the
  185.      detection of a FRU failure.
  186.  
  187.      #! /bin/csh -f
  188.      #
  189.      # If the status change is a failure, send mail to system
  190.      # administrator.
  191.      #
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ffffccccaaaaggggeeeennnntttt((((1111mmmm))))                                                        ffffccccaaaaggggeeeennnntttt((((1111mmmm))))
  203.  
  204.  
  205.  
  206.      set TMP="/tmp/statchanged_$$"
  207.  
  208.      if ("$2" == FAILURE) then
  209.           echo "$6 #$7 in enclosure $5 on channel $4 on host $1 FAILED at $3" > $TMP
  210.           Mail -s "FRU Failure" root@alpha.centauri.com < $TMP
  211.           /bin/rm -f $TMP
  212.      endif
  213.  
  214.  
  215.  
  216. FFFFIIIILLLLEEEESSSS
  217.      /usr/bin/fcagent
  218.      /etc/config/fcagent.options
  219.      /etc/init.d/fcagent
  220.  
  221.  
  222. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  223.      fccli(1M), chkconfig(1M), sesdaemon(1M), sesmgr(1M)
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.